Discovery of Performance Monitoring Entity

Use the following URLs to retrieve the performance monitoring value of specific entities (indexes). The following attributes are specified for the last interval:

■

id – performance monitoring name

■

value

URL

■

Singular entities:

/api/v1/kpi/current/<app>/<group>/<ent>
/api/v1/kpi/history/<app>/<group>/<ent>?interval=<idx>

■

Indexed entities:

/api/v1/kpi/current/<app>/<group>/<ent>/<id>
/api/v1/kpi/history/<app>/<group>/<ent>/<id>?interval=<idx>

HTTP Method

GET

Supported Parameters

Parameter	Type	Description
?before=<KPI Name>	Number	Returns all the performance monitoring parameters (information including values) that are listed before the specified performance monitoring parameter of the entity (index).
?after=<KPI Name>	Number	Returns all the performance monitoring parameters (information including values) that are listed after the specified performance monitoring parameter of the entity (index). For example: /api/v1/kpi/current/sbc/callStats/ipGroup/0?after=postDialDelay
?limit=<Count>	Number	Returns the first number (count) of listed performance monitoring parameters of the entity (index).
kpi=<Name>	String	Returns the value and information for the specified performance monitoring parameter of the entity (Index).
?interval=<Interval ID>	Number	Returns all the performance monitoring parameters (information including values) for a specified collection interval of the entity (index).
?detailed=true|false	String	When it equals false (default is enabled) some fields are not returned in the response (e.g., name and description).
<Cursor Information>	String	Returns next (after) or previous (before) results (see Cursor-based Pagination for more information).

HTTP Responses

■

200 OK

■

204 No Content – nothing to discover

■

400 Bad Request – bad query parameter or invalid path

Example 1

■

Request:

GET /api/v1/kpi/current/sbc/callStats/ipGroup/0 HTTP/1.1
Host: 10.4.219.229

■

Response:

  HTTP/1.1 200 OK
Content-Type: application/json
{
    "items": [
        {
            "id":"abnormalTerminatedCallsInTotal",
            "name": "Abnormal Terminated Calls In Total",
            "description": "Total number of abnormally terminated inbound calls (after connect)",
            "url": "/api/v1/kpi/current/sbc/callStats/ipGroup/0/abnormalTerminatedCallsInTotal",
            "value": "5"
        },
        {
            "id":"abnormalTerminatedCallsOutTotal",
            "name": "Abnormal Terminated Calls Out Total",
            "description": "Total number of abnormally terminated outbound calls (after connect)",
            "url": "/api/v1/kpi/current/sbc/callStats/ipGroup/0/abnormalTerminatedCallsOutTotal",
            "value": "0"
        },
       …
     ]
}

Example 2

■

Request:

GET /api/v1/kpi/current/sbc/callStats/ipGroup/0?limit=1 HTTP/1.1
Host: 10.4.219.229

■

Response:

 HTTP/1.1 200 OK
Content-Type: application/json
{
    "items": [
        {
            "id":"abnormalTerminatedCallsInTotal",
            "name": "Abnormal Terminated Calls In Total",
            "description": "Total number of abnormally terminated inbound calls (after connect)",
            "url": "/api/v1/kpi/current/sbc/callStats/ipGroup/0/abnormalTerminatedCallsInTotal",
            "value": "5"
        }
     ]
}

Example 3

■

Request:

GET /api/v1/kpi/current/sbc/callStats/ipGroup/0?kpi=attemptedCallsRateOut HTTP/1.1
Host: 10.4.219.229

■

Response:

 HTTP/1.1 200 OK
Content-Type: application/json
{
    "items": [
        {
            "id": "attemptedCallsRateOut",
            "name": "Attempted Calls Rate Out",
            "description": "Rate of attempted outbound calls (call attempts per second)",
            "url": "/api/v1/kpi/current/sbc/callStats/ipGroup/0/attemptedCallsRateOut",
            "value": "2"
        }
     ]
}